Payments
https://sandbox-products.ddp.akoya.com/payments/{version}/{providerId}/{accountId}/payment-networks
This product supports use cases such as payment enablement or account opening. The response includes identifiers necessary to make ACH and RTP payments. Identifiers include account number, routing number, identifier type (actual or tokenized account number), and payment network type such as ACH or RTP.
To see the response schema, select the 200 response below. For an example payload response, see the 200 example response below the Try it feature.
Path Parameters
version*
stringdefault: v2Akoya major version number. Do not use minor version numbers. For instance, use v2 and not v2.2
providerId*
stringdefault: mikomoId of provider
accountId*
stringdefault: :accountIdAccount Identifier
Headers
x-akoya-interaction-type
stringOptional but recommended header to include with each data request. Allowed values are `user` or `batch`. `user` indicates a request is prompted by an end-user action. `batch` indicates the request is part of a batch process.
batch
Responses
200
OK
Response Body
paymentNetworks
array of objects
Array of payment networks
object
bankId
string
Bank identifier used by the payment network ie. Routing Number
identifier
string
The number used to identify the account within the payment network. If identifierType is ACCOUNT_NUMBER, this is the account number.
identifierType
string
Type of identifier
type
string
Type of payment network
transferIn
boolean
Can transfer funds to the account using this information
transferOut
boolean
Can transfer funds from the account using this information
Headers
x-akoya-interaction-idstring
Akoya tracking id for logging or support.
401
602 - Customer does not have authorization to perform this action. The customer may have revoked access through provider and would need to reauthenticate.
Response Body
object
code
integer
Long term persistent identifier which can be used to trace error condition back to log information
message
string
End user displayable information which might help the customer diagnose an error
Headers
x-akoya-interaction-idstring
Akoya tracking id for logging or support.
403
403 - The `providerId` is wrong or your app doesn't have a subscription to the provider.
Response Body
object
code
integer
Long term persistent identifier which can be used to trace error condition back to log information
message
string
End user displayable information which might help the customer diagnose an error
Headers
x-akoya-interaction-idstring
Akoya tracking id for logging or support.
404
701 - Account not found. The `accountId` may be wrong.
Response Body
object
code
integer
Long term persistent identifier which can be used to trace error condition back to log information
message
string
End user displayable information which might help the customer diagnose an error
Headers
x-akoya-interaction-idstring
Akoya tracking id for logging or support.
Try it
Authorization
const options = {
"method": "GET",
"headers": {
"x-akoya-interaction-type": "batch"
}
}};
fetch('https://sandbox-products.ddp.akoya.com/payments/v2/mikomo/:accountId/payment-networks', options)
.then(response => response.json())
.catch(err => console.error(err));