Skip to main content
Logo
Identify a payment Support GoCardless
  1. Support Centre
  2. Partner integrations & the API
  3. Integrating with our API

API FAQs

  • Can I reset my sandbox account?
  • Do I need to use HTTPS or SSL?
  • Where do I find the request ID?
  • Why can I not use plans in the API?

Can I reset my sandbox account?

You’re not able to reset or delete information from your sandbox account, as it behaves exactly the same way as a live account.

If you need to start again, we’d recommend creating a new sandbox account here. If you need to use the same email address as your previous account, please just let us know at api@gocardless.com and we can close this account to allow you to use the email address again.

Do I need to use HTTPS or SSL?

In the live environment, you will need to have a valid SSL certificate and use HTTPS for Redirect URLs and your webhook endpoint. 

In sandbox, HTTPS is not enforced for testing purposes.

Where do I find the request ID?

When troubleshooting errors from the API, it’s often useful to include the request ID if you are trying to solve the issue with our developer support team.

The request ID is used to identify every request that reaches us. You can find the request ID within the "request_id" value in the "error" object in the response from the API e.g.

{
    "error": {
        "message": "The access token you've used is not a valid sandbox API access token",
        "errors": [
            {
                "reason": "access_token_not_found",
                "message": "The access token you've used is not a valid sandbox API access token"
            }
        ],
        "documentation_url": "https://developer.gocardless.com/api-reference#access_token_not_found",
        "type": "invalid_api_usage",
        "request_id": "23BF10A0DF08_0A1401AF1F92_617FCFC4_3AB30001",
        "code": 401
    }
}

The request ID will also be displayed if an unsuccessful request is made through a browser:

Screen Shot 2017-05-12 at 12.32.30.png
 

Why can I not use plans in the API?

Plans are a Dashboard feature, and so to charge recurring payments through the API you’ll need to use subscriptions.

You can create subscriptions to charge your customers weekly, monthly, yearly or something in between. You’ll just need the mandate ID of the customer you want to create a subscription for.

If you're using the GoCardless hosted payment pages, the mandate will be created when you complete the redirect flow. The API will then return the customer and mandate IDs, so at this point you can create a subscription or payment for the customer. 

You can see a full reference on creating subscriptions in our developer documentation here.

Was this article helpful?
  • Promoted articles

    • Credit card payments
    • Bulk importing payments
    • Overview of payment statuses
    • Refund a payment
  • Recently Added Articles

  • Top Articles

API Documentation

Our detailed docs have everything you need to know about using our Payments and Bank account data APIs

View documentation

Need help identifying a payment?

Seen ‘GoCardless Ltd’ on your bank statement? Use our secure tool below to find out more.

Payment Lookup

Need support?

Contact Support

Our support team are available 24/7 to answer any questions you may have.

Quick links

Knowledge base
Visit GoCardless.com

About GoCardless

Legal
Privacy
Security
Blog

Support

Contact support
Complaints
Contact sales

Seen ‘GoCardless Ltd’ on your bank statement?

Identify a payment

GoCardless Inc., 111 Congress Avenue, Suite 500, Austin, TX 78701


GoCardless Inc. (a Delaware Corporation, NMLS ID 2123932), is a FinCEN-registered money services business, registration number 31000261158426, and a licensed money transmitter in certain U.S. states. You can find further information about GoCardless Inc.‘s U.S. licenses and regulators’ contact information here.





English (US) Deutsch English (AU) English (CA) English (GB) English (NZ) Español Français
Search help articles
https://gocardless.com/en-us/partner-with-us/
/hc/theming_assets/01JKARFYGKK1KBMBMT9CC1BV8G
Partner with us
Partner with us to shape the future of payments.
custom
https://gocardless.com/en-us/stories/
/hc/theming_assets/01JKARFYZ7DNZC3PC7YMW92YZ4
Customer Stories
GoCardless helps thousands of businesses with their payments everyday.
custom
https://payersupport.gocardless.com/hc
/hc/theming_assets/01JXA8MEVXDJJHBYJVZ9TA240V
Paying a merchant via GoCardless
Our Payer Support provides resources on paying through GoCardless.
Payment timings, Verification, Xero, 2fa