Retrieve account program

Retrieves an account program by ID.

GET /v1/account_programs/{id}

JavaScript

JavaScript

import Augustus from '@augustusbank/typescript-sdk';

const client = new Augustus({
  apiKey: process.env['AUGUSTUS_API_KEY'], // This is the default and can be omitted
});

const accountProgram = await client.accountPrograms.retrieve(
  '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
);

console.log(accountProgram.id);

200

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "label": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z"
}

Authorizations

Authorization · string · header · required

Bearer token for authentication with Augustus Banking API

Path Parameters

id · string<uuid> · required

Unique identifier of the account program.

Response

200 - application/json

The account program resource

id · string<uuid> · required

Unique identifier of the account program.

type · enum<string> · required

Resource type discriminator.

Available options: account_program

label · string · required

Human-readable label for the account program.

account_program_type · enum<string> · required

Which for-benefit-of (FBO) program model applies: fbo_program (merchant program) or fbo_sponsored (sponsored program).

Available options: fbo_program, fbo_sponsored

status · enum<string> · required

Account program lifecycle status. Closed programs are not returned by this endpoint.

Available options: active, frozen

created_at · string<date-time> · required

ISO 8601 UTC timestamp when the account program was created.

updated_at · string<date-time> · required

ISO 8601 UTC timestamp when the account program was last updated.