Autogiro field mappings
The following table shows the Direct Debit SE (Autogiro) payment method field mapping relationship among the Zuora UI, Zuora API, and GoCardless API. It describes how Zuora fields are mapped to GoCardless API fields when creating a payment method. Updating the values of Zuora fields in Zuora will not update the values of GoCardless fields according to this mapping relationship.
Zuora UI field | Zuora API field | GoCardless API field | Description |
---|---|---|---|
N/A | PaymentMethod.TokenId | mandate_id | Zuora's PaymentMethod.TokenId field is not updatable. |
Mandate ID | PaymentMethod.MandateId | mandate_reference | Zuora's PaymentMethod.MandateId field maps to the GoCardless mandate_reference field but not the mandate_id field. Updating Zuora's PaymentMethod.MandateId will not update the mandate ID sent to GoCardless. Clearing the existing value of PaymentMethod.MandateId will not retrieve a new mandate ID, either. |
First Name | PaymentMethod.FirstName | given_name | If the Account Holder Name field is empty, this field is required. |
Last Name | PaymentMethod.LastName | family_name | If the Account Holder Name field is empty, this field is required. |
|
|
address_line1 | Required |
City | PaymentMethod.City | city | Required |
Postal Code | PaymentMethod.PostalCode | postal_code | Required |
Country | PaymentMethod.Country | country_code | Required. Must be one of the ISO 3166-1 alpha-2 codes. |
N/A | PaymentMethod.PaymentMethodId | z_payment_method_id | |
Account Number | Account.AccountNumber | z_account_number | |
Bank Transfer Account Number | PaymentMethod.BankTransferAccountNumber | account_number | Required |
Bank Transfer Account Name | PaymentMethod.BankTransferAccountName | account_holder_name | Required |
Bank Code | PaymentMethod.BankCode | branch_code | Required |
Bank Transfer Type | PaymentMethod.BankTransferType | scheme | Required |
Business Identification Code | PaymentMethod.BusinessIdentificationCode | swedish_identity_number danish_identity_number |
Required for Autogiro or Betalingsservice to create customers. |