PIpismo
Account

Get overdraft product details for an account

Get the details of an overdraft product attached to an account.

get/v1/overdraft/attachments/accounts/{accountId}

Request

  • Base URL
    https://sandbox.pismolabs.io/overdraft
  • URL
    https://sandbox.pismolabs.io/overdraft/v1/overdraft/attachments/accounts/{accountId}
  • Auth
    HTTP bearer

Path parameters

accountIdstring required

Account ID

Headers

AuthorizationTokenstring required

Account token. Token encoded with a Pismo account ID. Tokens can expire quickly, which can result in a 401 Unauthorized error.

x-account-idinteger required

Pismo account ID

Response

Get attachment details successful

account_idinteger

Pismo account ID

attach_datetimestring date-time

Datetime when the product was attached to the account. Format: YYYY-MM-DDThh:mm:ss.sss.

statusstring

Status of the product attachment

metadataobject

Additional details about the product attachment. The information must be in key:value pair format. For example, name:<your_name>.<br> minLength = 0 maxLength = 1024<br>

Note: This field must not be used to send Personally Identifiable Information (PII), Payment Card Industry (PCI) data, or any sensitive/regulated information. Metadata fields are intended for operational, non-sensitive data only. For sensitive data, use the specific parameters designed for that purpose. For more information, refer to Get started with Pismo APIs.

Example response

{
  "overdraft": {
    "name": "Overdraft Limit 1000",
    "processing_code": {
      "interest_processing_code": "123456"
    }
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.