Attach a source

POST / v1 / customers /:id / sources

Attaches a Source object to a Customer. The source must be in a chargeable or pending state.

Parameters

source string Required The identifier of the source to be attached.
metadata map Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to metadata.

Returns

Returns the attached Source object.

Response

{ "id": "src_1NfRGv2eZvKYlo2Cv7NAImBL", "object": "source", "ach_credit_transfer": { "account_number": "test_52796e3294dc", "routing_number": "110000000", "fingerprint": "ecpwEzmBOSMOqQTL", "bank_name": "TEST BANK", "swift_code": "TSTEZ122" }, "amount": 1000, "client_secret": "src_client_secret_sBqfX18eq6GPfGxGvVfMByCp", "created": 1692121393, "currency": "usd", "customer": "cus_9s6XKzkNRiz8i3", "flow": "receiver", "livemode": false, "metadata": {}, "owner": { "address": null, "email": "jenny.rosen@example.com", "name": null, "phone": null, "verified_address": null, "verified_email": null, "verified_name": null, "verified_phone": null }, "receiver": { "address": "121042882-38381234567890123", "amount_received": 1000, "amount_charged": 0, "amount_returned": 0, "refund_attributes_status": "missing", "refund_attributes_method": "email" }, "redaction": null, "statement_descriptor": null, "status": "chargeable", "type": "ach_credit_transfer", "usage": "reusable"}

Detach a source

DELETE / v1 / customers /:id / sources /:id

Detaches a Source object from a Customer. The status of a source is changed to consumed when it is detached and it can no longer be used to create a charge.

Parameters

No parameters.

Returns

Returns the detached Source object.

Response

{ "id": "src_1Nlghd2eZvKYlo2C6RFLJcv4", "object": "source", "ach_credit_transfer": { "account_number": "test_52796e3294dc", "routing_number": "110000000", "fingerprint": "ecpwEzmBOSMOqQTL", "bank_name": "TEST BANK", "swift_code": "TSTEZ122" }, "amount": 0, "client_secret": "src_client_secret_smKYWLhbzxzgLfvhKt1QeQOn", "created": 1693610677, "currency": "usd", "flow": "receiver", "livemode": false, "metadata": {}, "owner": { "address": null, "email": "jenny.rosen@example.com", "name": null, "phone": null, "verified_address": null, "verified_email": null, "verified_name": null, "verified_phone": null }, "receiver": { "address": "121042882-38381234567890123", "amount_received": 1000, "amount_charged": 1000, "amount_returned": 0, "refund_attributes_status": "missing", "refund_attributes_method": "email" }, "redaction": null, "statement_descriptor": null, "status": "consumed", "type": "ach_credit_transfer", "usage": "reusable", "customer": "cus_9s6XKzkNRiz8i3"}