GOgocardless
requisitions

POST /api/v2/requisitions/

Create a new requisition

Request

  • Base URL
    https://bankaccountdata.gocardless.com
  • Auth
    HTTP bearer

Request body

redirectstring uri nullable required

redirect URL to your application after end-user authorization with ASPSP

institution_idstring required

an Institution ID for this Requisition

agreementstring uuid

EUA associated with this requisition

referencestring

additional ID to identify the end user

user_languagestring

A two-letter country code (ISO 639-1)

ssnstring

optional SSN field to verify ownership of the account

account_selectionboolean

option to enable account selection view for the end user

redirect_immediateboolean

enable redirect back to the client after account list received

Response

Requisition has been successfully created

idstring uuid
createdstring date-time nullable

The date & time at which the requisition was created.

redirectstring uri nullable required

redirect URL to your application after end-user authorization with ASPSP

status'CR' | 'ID' | 'LN' | 'RJ' | 'ER' | 'SU' | 'EX' | 'GC' | 'UA' | 'GA' | 'SA'
institution_idstring required

an Institution ID for this Requisition

agreementstring uuid

EUA associated with this requisition

referencestring

additional ID to identify the end user

user_languagestring

A two-letter country code (ISO 639-1)

linkstring uri

link to initiate authorization with Institution

ssnstring

optional SSN field to verify ownership of the account

account_selectionboolean

option to enable account selection view for the end user

redirect_immediateboolean

enable redirect back to the client after account list received

Changes

No recorded changes to this operation across all 1 revision of this API.