Sign in
latestSwagger 2.02026-08-20196638916.1 KB

23d8982b533d

Payment.Settlement Accounts

Create account

Creates a new settlement account for the merchant.

post/payment/v1/merchants/{merchantId}/accounts

Path parameters

merchantIdstring required

The merchant id tied to the account.

Request body

appIdstring

The app id of the account.

countryCodestring

The country code (ISO 3166-1 alpha-2) of the desired location for the account. Optional.

currencyCodestring required

The currency code of the account.

idstring

The id of the account. Output only.

merchantIdstring required

The merchant id tied to the account.

namestring required

The name of the account. It should be the name of the company/shop of which the transaction is intended to.

status'STATUS_UNSPECIFIED' | 'ENABLED' | 'SUSPENDED' | 'TERMINATED'
  • STATUS_UNSPECIFIED: Default unspecified status.
  • ENABLED: Indicating that the account is operating.
  • SUSPENDED: Indicating that the account was suspended.
  • TERMINATED: Indicating that the account was terminated.
type'TYPE_UNSPECIFIED' | 'APP_ACCOUNT' | 'ACQUIRER_ACCOUNT'
  • TYPE_UNSPECIFIED: Default unspecified account type.
  • APP_ACCOUNT: An individual account owned solely by a single merchant.
  • ACQUIRER_ACCOUNT: A managed account with a primary owner and additional merchants.

Example request

{
  "accountIdentifier": {
    "identifier": "00000012345678",
    "type": "SORT_CODE"
  },
  "appId": "",
  "availableBalance": {
    "currencyCode": "GBP",
    "value": {
      "scale": "2",
      "unscaledValue": "271100"
    }
  },
  "balance": {
    "currencyCode": "GBP",
    "value": {
      "scale": "2",
      "unscaledValue": "276400"
    }
  },
  "countryCode": "GB",
  "currencyCode": "GBP",
  "id": "744cf927-29cd-475e-9ef2-2b11951d3cc9",
  "merchantId": "2c9ba5fd-cbdb-4ed5-84a4-01db5698f0d9",
  "name": "Account name",
  "payoutAccount": {
    "currencyCode": "GBP",
    "frequency": "MONTHLY",
    "identifier": {
      "identifier": "00000070438943",
      "type": "SORT_CODE"
    }
  },
  "reservedAmount": {
    "scale": "1",
    "unscaledValue": "100"
  },
  "status": "ENABLED",
  "type": "APP_ACCOUNT"
}

Response

A successful response.

appIdstring

The app id of the account.

countryCodestring

The country code (ISO 3166-1 alpha-2) of the desired location for the account. Optional.

currencyCodestring required

The currency code of the account.

idstring

The id of the account. Output only.

merchantIdstring required

The merchant id tied to the account.

namestring required

The name of the account. It should be the name of the company/shop of which the transaction is intended to.

status'STATUS_UNSPECIFIED' | 'ENABLED' | 'SUSPENDED' | 'TERMINATED'
  • STATUS_UNSPECIFIED: Default unspecified status.
  • ENABLED: Indicating that the account is operating.
  • SUSPENDED: Indicating that the account was suspended.
  • TERMINATED: Indicating that the account was terminated.
type'TYPE_UNSPECIFIED' | 'APP_ACCOUNT' | 'ACQUIRER_ACCOUNT'
  • TYPE_UNSPECIFIED: Default unspecified account type.
  • APP_ACCOUNT: An individual account owned solely by a single merchant.
  • ACQUIRER_ACCOUNT: A managed account with a primary owner and additional merchants.

Example response

{
  "accountIdentifier": {
    "identifier": "00000012345678",
    "type": "SORT_CODE"
  },
  "appId": "",
  "availableBalance": {
    "currencyCode": "GBP",
    "value": {
      "scale": "2",
      "unscaledValue": "271100"
    }
  },
  "balance": {
    "currencyCode": "GBP",
    "value": {
      "scale": "2",
      "unscaledValue": "276400"
    }
  },
  "countryCode": "GB",
  "currencyCode": "GBP",
  "id": "744cf927-29cd-475e-9ef2-2b11951d3cc9",
  "merchantId": "2c9ba5fd-cbdb-4ed5-84a4-01db5698f0d9",
  "name": "Account name",
  "payoutAccount": {
    "currencyCode": "GBP",
    "frequency": "MONTHLY",
    "identifier": {
      "identifier": "00000070438943",
      "type": "SORT_CODE"
    }
  },
  "reservedAmount": {
    "scale": "1",
    "unscaledValue": "100"
  },
  "status": "ENABLED",
  "type": "APP_ACCOUNT"
}