Paykeys

Unmask a paykey

Changed on

Retrieves the unmasked details of an existing paykey. Supply the unique paykey id and Straddle will return the corresponding paykey record, including the unmasked bank account details. This endpoint needs to be enabled by Straddle for your account and should only be used when absolutely necessary.

get/v1/paykeys/{id}/unmasked

Request

  • Base URL
    https://sandbox.straddle.com
  • URL
    https://sandbox.straddle.com/v1/paykeys/{id}/unmasked
  • Auth
    HTTP bearer

Path parameters

idstring uuid required

Headers

Straddle-Account-Idstring uuid

For use by platforms to specify an account id and set scope of a request.

Request-Idstring

Optional client generated identifier to trace and debug a request.

Correlation-Idstring

Optional client generated identifier to trace and debug a series of requests.

Response

OK

response_type'object' | 'array' | 'error' | 'none' required

Indicates the structure of the returned content.

  • "object" means the data field contains a single JSON object.
  • "array" means the data field contains an array of objects.
  • "error" means the data field contains an error object with details of the issue.
  • "none" means no data is returned.

Example response

{
  "data": {
    "institution_name": "Bank of America",
    "status_details": {
      "message": "Bank account sucesfully validated"
    },
    "bank_data": {
      "routing_number": "021000021",
      "account_number": "123456789"
    }
  }
}

Changes

  • de39a60c562eRevision changes
    • warning

      added the new mastercard enum value to the / response property for the response status (media type: text/plain)

    • warning

      added the new mastercard enum value to the / response property for the response status (media type: application/json)

    • warning

      added the new mastercard enum value to the / response property for the response status (media type: text/json)

  • 456c9ef0c3a6Revision changes
    • warning

      added the new auto_hold enum value to the // response property for the response status (media type: text/plain)

    • warning

      added the new auto_hold enum value to the // response property for the response status (media type: application/json)

    • warning

      added the new auto_hold enum value to the // response property for the response status (media type: text/json)

    • warning

      added the new validating enum value to the // response property for the response status (media type: text/plain)

    • warning

      added the new validating enum value to the // response property for the response status (media type: application/json)

    • warning

      added the new validating enum value to the // response property for the response status (media type: text/json)