RegisterAccount

Overview

Registers and verifies the format of an account to be used in AccountPayout.

A typical payout flow is:

1. The merchant makes an API-call to RegisterAccount and receives an accountid in response.
2. The merchant saves the accountid as a valid payout option for the end user.
3. When it's time to actually do a payout the merchant makes an API-call to AccountPayout with the Amount, Currency and saved accountid.

Multiple calls to RegisterAccount with the same bank account details will result in the same accountid being returned.

Request example

If a RegisterAccount request is not accepted, an error message will be returned.

{
  "method": "RegisterAccount",
  "params": {
    "Data": {
      "AccountNumber": "69706212",
      "Attributes": {
        "AddressCountry": "SE",
        "AddressPostalCode": "SE-11253",
        "AddressCity": "Stockholm",
        "AddressLine1": "Main street 1",
        "MobilePhone": "+46709876543",
        "NationalIdentificationNumber": "900219-1234",
        "Email": "[email protected]",
        "DateOfBirth": "1990-02-19"
      },
      "BankNumber": "6112",
      "ClearingHouse": "SWEDEN",
      "EndUserID": "123123",
      "Firstname": "Steve",
      "Lastname": "Smith",
      "Password": "merchant_password",
      "Username": "merchant_username"
    },
    "Signature": "zKwo[...]iTPMc14be138", 
    "UUID": "258a2184-2842-b485-25ca-293525152425"
  },
  "version": "1.1"
}

Request parameters

AccountNumber format

The format of the BankNumber and AccountNumber varies for different countries. For some counties the AccountNumber number should be provided in IBAN format, and in those cases the BankNumber should be provided as an empty string (our system can derive the BIC/SWIFT code from the IBAN).

For other countries the AccountNumber and BankNumber should be provided in the local country-specific format. AccountNumbers that start with 2 letters are IBAN numbers, while the ones starting with numbers are country-specific.

🚧

The BankNumber for Swedish bank accounts should be the local "clearing number", and the AccountNumber parameter should contain the rest of the account number. Most Swedish banks have a 4-digit clearing number, but a 5-digit clearing number is used for Swedbank accounts when the clearing number starts with "8". Nordea accounts where the account number is the same as the person's national identification number always has "3300" as the clearing number.

IBAN for Swedish bank accounts is supported upon request. When making API calls with Swedish IBAN, ensure to include the Clearinghouse attribute as "IBAN" instead of "SWEDEN".

{
    ...
    "ClearingHouse": "SPAIN",
    "BankNumber": "",
    "AccountNumber": "ES8701820004756386447000",
    ...
}

{
    ...
    "ClearingHouse": "SWEDEN",
    "BankNumber": "83279",
    "AccountNumber": "9048832662",
    ...
}

Attributes

The parameter Attributes is an object of attributes.

Note: New attributes may be added in future versions of the API, but existing attributes will never be removed.

Response example

{
    "result": {
        "signature": "R9+hjuMqbsH0Ku ... S16VbzRsw==",
        "uuid": "258a2184-2842-b485-25ca-293525152425",
        "method": "RegisterAccount",
        "data": {
            "accountid": "7653385737",
            "clearinghouse": "SWEDEN",
            "bank": "Handelsbanken",
            "descriptor": "**706212"
        }
    },
    "version": "1.1"
}

Response attributes

The result returned is a hash with the following attributes. New attributes may be added to the result in future versions of the API.

Error codes

These error codes can be returned for RegisterAccount calls. To handle errors, see Error handling.