GoCardlessDeveloper Docs
Create a sandbox account

Transferred Mandate

View as Markdown

Mandates that have been transferred using Current Account Switch Service

Get updated customer bank details#

GET/transferred_mandates/{mandate_id}

Returns new customer bank details for a mandate that's been recently transferred

Path Parameters

NameTypeDescription
mandate_idrequiredstring

The mandate id

GET https://api.gocardless.com/transferred_mandates/MD123 HTTP/1.1
Content-Type: application/json
@client.transferred_mandates.transferred_mandates("MD123")
client.transferred_mandates.transferred_mandates("MD123")
const transferredMandate = await client.transferredMandates.transferredMandates("MD123");
$client->transferredMandates()->transferredMandates("MD123");
client.transferredMandates().transferredMandates("MD123").execute();
transferredMandate, err := client.TransferredMandates.TransferredMandates(ctx, "MD123", gocardless.TransferredMandateTransferredMandatesParams{})
var response = await client.TransferredMandates.TransferredMandatesAsync("MD123");
GoCardless.Resources.TransferredMandate transferredMandate = response.TransferredMandate;
Responsehttp
HTTP/1.1 200 (OK)
Location: /transferred_mandates/MD123
Content-Type: application/json
{
 "transferred_mandates": {
   "encrypted_decryption_key": "bXktZW5jcnlvcHRlZC1hZXMta2V5",
   "public_key_id": "9770a024c90fb646e48c952ec5d4f53586e62e8154048e6b96dd9f74f164a472",
   "encrypted_customer_bank_details": "OTc3MGEwMjRjOTBmYjY0NmU0OGM5NTJlYzVkNGY1MzU4NmU2MmU4MTU0MDQ4ZTZiOTZkZDlmNzRmMTY0YTQ3Mg==",
   "links": {
     "customer_bank_account": "BA123",
     "mandate": "MD123"
   }
 }
}
Response 200

Successful response

transferred_mandatesobject
4 properties
encrypted_decryption_keystring

Random AES-256 key used to encrypt bank account details, itself encrypted with your public key.

public_key_idstring

The ID of an RSA-2048 public key, from your JWKS, used to encrypt the AES key.

encrypted_customer_bank_detailsstring

Encrypted customer bank account details, containing: iban, account_holder_name, swift_bank_code, swift_branch_code, swift_account_number

linksobject
2 properties
customer_bank_accountstring

The ID of the updated customer_bank_account

mandatestring

The ID of the transferred mandate

Errors 400401404422500
400

Bad Request

401

Unauthorised

404

Not found

422

Validation Error

500

Internal Error

Error Body
codeinteger
documentation_urlstring
errorsarray
2 properties
reasonstring
messagestring
messagestring
request_idstring
typestring
metadataobject
linksobject
SupportDashboard